<?xml version="1.0"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head><title>SASAPI</title><script src="../../../quicknav.js" type="text/javascript"></script><script><!--
document.quicknavBasePath="../../../index-files";
//--></script><link href="../../../style.css" title="JavaDoc" rel="stylesheet" type="text/css"/><link href="../../../unnatural.css" title="Unnatural" rel="alternate stylesheet" type="text/css"/><link href="../../../overview-summary.html" title="Overview" rel="top"/><meta name="generator" content="http://www.badgers-in-foil.co.uk/projects/as2api/"/></head><body><pre><span class="lineno" id="1">     1  </span><span class="comment doc">/**
<span class="lineno" id="2">     2  </span> * com.sekati.display.BaseClip
<span class="lineno" id="3">     3  </span> * @version 1.1.5
<span class="lineno" id="4">     4  </span> * @author jason m horwitz | sekati.com
<span class="lineno" id="5">     5  </span> * Copyright (C) 2007  jason m horwitz, Sekat LLC. All Rights Reserved.
<span class="lineno" id="6">     6  </span> * Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
<span class="lineno" id="7">     7  </span> */</span>
<span class="lineno" id="8">     8  </span>
<span class="lineno" id="9">     9  </span><span class="key">import</span> com.sekati.display.IBaseClip;
<span class="lineno" id="10">    10  </span><span class="key">import</span> com.sekati.display.ITweenClip;
<span class="lineno" id="11">    11  </span><span class="key">import</span> com.sekati.core.KeyFactory;
<span class="lineno" id="12">    12  </span><span class="key">import</span> com.sekati.except.IllegalArgumentException;
<span class="lineno" id="13">    13  </span><span class="key">import</span> com.sekati.reflect.Stringifier;
<span class="lineno" id="14">    14  </span><span class="key">import</span> com.sekati.utils.MovieClipUtils;
<span class="lineno" id="15">    15  </span><span class="key">import</span> com.sekati.validate.TypeValidation;
<span class="lineno" id="16">    16  </span><span class="key">import</span> caurina.transitions.Tweener;
<span class="lineno" id="17">    17  </span>
<span class="lineno" id="18">    18  </span><span class="comment doc">/**
<span class="lineno" id="19">    19  </span> * This is the foundational MovieClip class and should be
<span class="lineno" id="20">    20  </span> * thought of as the main building block of the SASAPI framework.
<span class="lineno" id="21">    21  </span> * @see {@link com.sekati.display.CoreClip}
<span class="lineno" id="22">    22  </span> */</span>
<span class="lineno" id="23">    23  </span><span class="key">class</span> com.sekati.display.BaseClip <span class="key">extends</span> MovieClip <span class="key">implements</span> IBaseClip, ITweenClip {
<span class="lineno" id="24">    24  </span>
<span class="lineno" id="25">    25  </span>	<span class="key">private</span> <span class="key">var</span> _this:MovieClip;
<span class="lineno" id="26">    26  </span>	<span class="key">private</span> <span class="key">var</span> __isClean:Boolean;
<span class="lineno" id="27">    27  </span>
<span class="lineno" id="28">    28  </span>	<span class="key">public</span> <span class="key">function</span> BaseClip() {
<span class="lineno" id="29">    29  </span>		_this = <span class="key">this</span>;
<span class="lineno" id="30">    30  </span>		__isClean = <span class="key">false</span>;
<span class="lineno" id="31">    31  </span>		KeyFactory.inject( _this );
<span class="lineno" id="32">    32  </span>	}
<span class="lineno" id="33">    33  </span>
<span class="lineno" id="34">    34  </span>	<span class="comment doc">/**
<span class="lineno" id="35">    35  </span>	 * if destroy hasnt already been called manually
<span class="lineno" id="36">    36  </span>	 * run it onUnload.
<span class="lineno" id="37">    37  </span>	 */</span>
<span class="lineno" id="38">    38  </span>	<span class="key">public</span> <span class="key">function</span> onUnload():Void {
<span class="lineno" id="39">    39  </span>		<span class="key">if</span>(!__isClean) {
<span class="lineno" id="40">    40  </span>			destroy( );
<span class="lineno" id="41">    41  </span>		}	
<span class="lineno" id="42">    42  </span>	}
<span class="lineno" id="43">    43  </span>
<span class="lineno" id="44">    44  </span>	<span class="comment doc">/**
<span class="lineno" id="45">    45  </span>	 * Destroy object elements and events for proper garbage collection.
<span class="lineno" id="46">    46  </span>	 * This is a generic destroy method to insure that, at a minimum, the 
<span class="lineno" id="47">    47  </span>	 * enterFrame and clip itself are removed when destroy is called. 
<span class="lineno" id="48">    48  </span>	 * This behavior can be overwritten by BaseClip's subclasses. 
<span class="lineno" id="49">    49  </span>	 * If you wish to use BaseClip's destroy in addition to your subclass 
<span class="lineno" id="50">    50  </span>	 * destroy you may do so via: 
<span class="lineno" id="51">    51  </span>	 * {@code
<span class="lineno" id="52">    52  </span>	 * 	super.destroy(); 
<span class="lineno" id="53">    53  </span>	 * }
<span class="lineno" id="54">    54  </span>	 */</span>	
<span class="lineno" id="55">    55  </span>	<span class="key">public</span> <span class="key">function</span> destroy():Void {
<span class="lineno" id="56">    56  </span>		__isClean = <span class="key">true</span>;
<span class="lineno" id="57">    57  </span>		_this.onEnterFrame = <span class="key">null</span>;
<span class="lineno" id="58">    58  </span>		<span class="comment">/*
<span class="lineno" id="59">    59  </span>		 * VERY DANGEROUS BUGS CAN OCCUR WHEN EXTENDING 
<span class="lineno" id="60">    60  </span>		 * BASECLIP WITH THIS LOOP INCLUDED!
<span class="lineno" id="61">    61  </span>		for(var i in _this) {
<span class="lineno" id="62">    62  </span>		MovieClipUtils.rmClip(_this[i]);	
<span class="lineno" id="63">    63  </span>		}
<span class="lineno" id="64">    64  </span>		 */</span>
<span class="lineno" id="65">    65  </span>		MovieClipUtils.rmClip( _this );		
<span class="lineno" id="66">    66  </span>	}
<span class="lineno" id="67">    67  </span>
<span class="lineno" id="68">    68  </span>	<span class="comment doc">/**
<span class="lineno" id="69">    69  </span>	 * Built-in {@link com.sekati.transitions.Tweener.addTween} wrapper. The method 
<span class="lineno" id="70">    70  </span>	 * accepts either one argument (TweenerObject) or two arguments (target, TweenerObject).
<span class="lineno" id="71">    71  </span>	 * {@code Usage:
<span class="lineno" id="72">    72  </span>	 * 	tween({_x:100, time:1, transition:"linear"});
<span class="lineno" id="73">    73  </span>	 * 	tween(someOtherMc, {_x:100, time:1, transition:"linear"});
<span class="lineno" id="74">    74  </span>	 * }
<span class="lineno" id="75">    75  </span>	 * @see {@link http://hosted.zeh.com.br/tweener/docs/en-us/}
<span class="lineno" id="76">    76  </span>	 * @return Void
<span class="lineno" id="77">    77  </span>	 */</span>
<span class="lineno" id="78">    78  </span>	<span class="key">public</span> <span class="key">function</span> tween():Void {
<span class="lineno" id="79">    79  </span>		<span class="key">if</span> (arguments.length == <span class="num_const">1</span>) {
<span class="lineno" id="80">    80  </span>			Tweener.addTween( _this, arguments[<span class="num_const">0</span>] );
<span class="lineno" id="81">    81  </span>		} <span class="key">else</span> <span class="key">if</span> (TypeValidation.isMovieClip( arguments[<span class="num_const">0</span>] ) || TypeValidation.isTextField( arguments[<span class="num_const">0</span>] )) {
<span class="lineno" id="82">    82  </span>			Tweener.addTween( arguments[<span class="num_const">0</span>], arguments[<span class="num_const">1</span>] );	
<span class="lineno" id="83">    83  </span>		} <span class="key">else</span> {
<span class="lineno" id="84">    84  </span>			<span class="key">throw</span> <span class="key">new</span> IllegalArgumentException( <span class="key">this</span>, <span class="str_const">"BaseClip.tween requires either (tweenerObject) or (target, tweenerObject) arguments."</span>, arguments );
<span class="lineno" id="85">    85  </span>		}
<span class="lineno" id="86">    86  </span>	}
<span class="lineno" id="87">    87  </span>
<span class="lineno" id="88">    88  </span>	<span class="comment doc">/**
<span class="lineno" id="89">    89  </span>	 * Remove any or all Tweener tweens on the instance object using arguments array.
<span class="lineno" id="90">    90  </span>	 * @param arguments
<span class="lineno" id="91">    91  </span>	 * @return Void
<span class="lineno" id="92">    92  </span>	 */</span>
<span class="lineno" id="93">    93  </span>	<span class="key">public</span> <span class="key">function</span> stopTween():Void {
<span class="lineno" id="94">    94  </span>		<span class="key">var</span> args:Array = [ _this ];
<span class="lineno" id="95">    95  </span>		<span class="key">for</span> (<span class="key">var</span> i:Number = <span class="num_const">0</span>; i &lt; arguments.length ; i++) {
<span class="lineno" id="96">    96  </span>			args.push( arguments[i] );
<span class="lineno" id="97">    97  </span>		}
<span class="lineno" id="98">    98  </span>		Tweener.removeTweens.apply( <span class="key">this</span>, args );
<span class="lineno" id="99">    99  </span>	}
<span class="lineno" id="100">   100  </span>
<span class="lineno" id="101">   101  </span>	<span class="comment doc">/**
<span class="lineno" id="102">   102  </span>	 * return reflective output
<span class="lineno" id="103">   103  </span>	 * @return String
<span class="lineno" id="104">   104  </span>	 */</span>	
<span class="lineno" id="105">   105  </span>	<span class="key">public</span> <span class="key">function</span> toString():String {
<span class="lineno" id="106">   106  </span>		<span class="key">return</span> Stringifier.stringify( <span class="key">this</span> );
<span class="lineno" id="107">   107  </span>	}
<span class="lineno" id="108">   108  </span>}</pre><ul class="main_nav" id="main_nav"><li><a href="../../../overview-summary.html" title="Overview of SASAPI" class="button">Overview</a></li><li><a href="package-summary.html" title="Overview of package com.sekati.display" class="button">Package</a></li><li><a href="BaseClip.html" title="Detail of com.sekati.display.BaseClip API" class="button">Class</a></li><li><span class="button nav_current">Source</span></li><li><a href="../../../index-files/index.html" title="Alpabetical index of types and members" class="button">Index</a></li></ul><div class="footer"><a href="http://www.badgers-in-foil.co.uk/projects/as2api/" title="ActionScript 2 API Documentation Generator">as2api</a></div></body></html>